/*
 * jPOS Project [http://jpos.org]
 * Copyright (C) 2000-2015 Alejandro P. Revilla
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.jpos.iso;

import org.jpos.iso.packager.XMLPackager;

import java.io.InputStream;
import java.io.PrintStream;
import java.util.BitSet;

/**
 * implements <b>Leaf</b> for Bitmap field
 *
 * @author apr@cs.com.uy
 * @version $Id$
 * @see ISOComponent
 */
public class ISOBitMap extends ISOComponent implements Cloneable {
	protected int fieldNumber;
	protected BitSet value;

	/**
	 * @param n - the FieldNumber
	 */
	public ISOBitMap(int n) {
		fieldNumber = n;
	}

	/**
	 * @param n - fieldNumber
	 * @param v - field value (Bitset)
	 * @see BitSet
	 */
	public ISOBitMap(int n, BitSet v) {
		fieldNumber = n;
		value = v;
	}

	/**
	 * changes this Component field number<br>
	 * Use with care, this method does not change
	 * any reference held by a Composite.
	 *
	 * @param fieldNumber new field number
	 */
	public void setFieldNumber(int fieldNumber) {
		this.fieldNumber = fieldNumber;
	}

	@Override
	public int getFieldNumber() {
		return fieldNumber;
	}

	/**
	 * not available on Leaf - always throw ISOException
	 *
	 * @throws ISOException
	 */
	public byte[] pack() throws ISOException {
		throw new ISOException("Not available on Leaf");
	}

	/**
	 * not available on Leaf - always throw ISOException
	 *
	 * @throws ISOException
	 */
	public int unpack(byte[] b) throws ISOException {
		throw new ISOException("Not available on Leaf");
	}

	/**
	 * not available on Leaf - always throw ISOException
	 *
	 * @throws ISOException
	 */
	public void unpack(InputStream in) throws ISOException {
		throw new ISOException("Not available on Leaf");
	}

	/**
	 * @return Object representing this field number
	 */
	public Object getKey() {
		return fieldNumber;
	}

	/**
	 * @return Object representing this field value
	 */
	public Object getValue() {
		return value;
	}

	/**
	 * @param obj - Object representing this field value
	 * @throws ISOException
	 */
	public void setValue(Object obj) throws ISOException {
		value = (BitSet) obj;
	}

	/**
	 * dump this field to PrintStream. The output is sorta
	 * XML, intended to be easily parsed.
	 *
	 * @param p      - print stream
	 * @param indent - optional indent string
	 */
	public void dump(PrintStream p, String indent) {
		p.println(indent + "<" + XMLPackager.ISOFIELD_TAG + " " +
						XMLPackager.ID_ATTR + "=\"" + XMLPackager.TYPE_BITMAP + "\" " +
						XMLPackager.VALUE_ATTR + "=\"" + value + "\" " +
						XMLPackager.TYPE_ATTR + "=\"" + XMLPackager.TYPE_BITMAP + "\"/>"
		);
	}
}
